GetSyncErrorDescription

GetSyncErrorDescription(errnum)

Obtain an error message describing a synchronisation failure during the last call to the Synchronise Method.

All

errnum - required

Position of the error message in the list of available messages. The first error message has a position of 1.

String containing the error message.

This Method is used in conjunction with the GetNumSyncErrors, GetSyncErrorDataSource and GetSyncErrorRecordIndex Methods to retrieve error messages should a call to the Synchronise Method be unsuccessful in part or whole. These Methods can be used to retrieve any error messages resulting from the last call to Synchronise for both synchronous and asynchronous transfers.

GetNumSyncErrors tells you if there were any errors during the last sync, and, if there were, how many there are. You can then use the other Methods to retrieve the error messages and find out the location of failed records in the local database on the device.

The errnum parameter specifies the position of the error you want to query in the current list of available errors. The first error in the list is in position 1.

See the description for GetSyncErrorRecordIndex for more information and an example of how to use these Methods.